DigiOffice Gateway Web Services

<back to all web services

ProcessDocumentRequestMessage

export class Environment
{
    public Title: string;
    public Code: string;

    public constructor(init?: Partial<Environment>) { (Object as any).assign(this, init); }
}

export class Party
{
    public Title: string;
    public Code: string;
    public Version: string;
    public Environment: Environment;

    public constructor(init?: Partial<Party>) { (Object as any).assign(this, init); }
}

export class Header
{
    public MessageID: string;
    public Timestamp: string;
    public Sender: Party;
    public Recipient: Party;
    public RequestMessageID: Object;

    public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}

export enum eventType
{
    Update = 'Update',
    Create = 'Create',
    Delete = 'Delete',
    Response = 'Response',
}

export class Document implements ICustomProperties
{
    public ID: string;
    public RootDocumentID: string;
    public RegistrationprofileID: string;
    public Title: string;
    public FullTitle: string;
    public Number: string;
    public Version: string;
    public ExternalNumber: string;
    public ExternalVersion: string;
    public InternalNumber: string;
    public InternalInvoiceNumber: string;
    public PersonID: number;
    public RelationID: number;
    public RelationTitle: string;
    public ProjectID: number;
    public ProjectTitle: string;
    public Extension: string;
    public Date?: string;
    public CommentsCount: number;
    public HasComments: boolean;
    public HasPreview: boolean;
    public ExtraField: string;
    public IsFavorite: boolean;
    public DocumentcategoryText: string;
    public FileSize?: number;
    public FileDate?: string;
    public Hash: string;
    public HashType: string;
    public FileUrl: string;
    public StandardDocumentUrl: string;
    public IsCorporateIdentity: boolean;
    public UserTitle: string;
    public IsFrozen: boolean;
    public InternalCompanyID: number;
    public DirectUrl: string;
    public AllowDigitalSigningOnlyOnPrimaryVersions: boolean;
    public IsPrimaryVersion: boolean;
    public FileExtension: string;
    public CustomProperties: { [index: string]: Object; };

    public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}

export class DocumentMessage
{
    public Header: Header;
    public EventType: eventType;
    public Document: Document;

    public constructor(init?: Partial<DocumentMessage>) { (Object as any).assign(this, init); }
}

export class DocumentRequestMessage
{
    public Header: Header;
    public RootDocumentID: string;
    public IncludePhysicalFile: boolean;

    public constructor(init?: Partial<DocumentRequestMessage>) { (Object as any).assign(this, init); }
}

export class ProcessDocumentRequestMessage
{
    public InstanceId: string;
    public DocumentRequest: DocumentRequestMessage;

    public constructor(init?: Partial<ProcessDocumentRequestMessage>) { (Object as any).assign(this, init); }
}

TypeScript ProcessDocumentRequestMessage DTOs

POST /jsv/reply/ProcessDocumentRequestMessage HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentRequest: 
	{
		Header: 
		{
			MessageID: String,
			Timestamp: 0001-01-01,
			Sender: 
			{
				Title: String,
				Code: String,
				Version: String,
				Environment: 
				{
					Title: String,
					Code: String
				}
			},
			Recipient: 
			{
				Title: String,
				Code: String,
				Version: String,
				Environment: 
				{
					Title: String,
					Code: String
				}
			},
			RequestMessageID: {}
		},
		RootDocumentID: String,
		IncludePhysicalFile: False
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		MessageID: String,
		Timestamp: 0001-01-01,
		Sender: 
		{
			Title: String,
			Code: String,
			Version: String,
			Environment: 
			{
				Title: String,
				Code: String
			}
		},
		Recipient: 
		{
			Title: String,
			Code: String,
			Version: String,
			Environment: 
			{
				Title: String,
				Code: String
			}
		},
		RequestMessageID: {}
	},
	EventType: Update,
	Document: 
	{
		GlobalID: String,
		RootDocumentID: String,
		Code: String,
		Subject: String,
		VersionNumber: String,
		NewestVersion: False,
		RelationReference: 
		{
			GlobalID: String,
			Title: String
		},
		DocumentTypeReference: 
		{
			GlobalID: String,
			Title: String
		},
		ProjectReference: 
		{
			GlobalID: String,
			Title: String
		},
		ConstructionBlockReference: 
		{
			GlobalID: String,
			Title: String
		},
		ConstructionNumberReference: 
		{
			GlobalID: String,
			Title: String
		},
		HousingTypeReference: 
		{
			GlobalID: String,
			Title: String
		},
		Floor: 0,
		FloorSpecified: False,
		DeletedDate: 0001-01-01,
		DeletedDateSpecified: False,
		File: 
		{
			Type: String,
			Name: String,
			Size: 0,
			Content: String,
			ModifiedDate: 0001-01-01
		},
		CustomFields: 
		[
			{
				Name: String,
				Value: String
			}
		],
		CreationDate: 0001-01-01,
		CreatedBy: String,
		ModifiedDate: 0001-01-01,
		ModifiedBy: String
	}
}